How to Use - Functional & Technical Details
Functional Flow (End-to-End Task Lifecycle)
SETUP TIME
1. Configure System Master -> 2. Configure Scheduler
3. Upload YAML Configs -> 4. Verify Connectivity
RUNTIME (Automated)
5. Scheduler Pulls Tasks -> 6. JSON Flattened & Mapped
7. Batch Upserted to DB -> 8. Cache Evicted in ITM
RUNTIME (User)
9. User Sees Tasks in ITM -> 10. Claims/Reviews Task
11. Takes Action -> 12. Action Sent to Source System
13. Audit Recorded -> 14. Cache Evicted
MONITORING
15. Check Job Logs -> 16. Review Audit Trail -> 17. Debug Issues
Technical Usage - API Call Sequence
Setup a New Source System Connection
1. POST /system-schedule/config
2. POST /v1/yaml/upload
3. POST /v1/yaml/upload
4. POST /worknet/composite-api/parser/runJob
5. GET /system-schedule/lastRunOn
Process Tasks
1. (Automated) Scheduler pulls tasks -> Tasks appear in ITM
2. POST /task/actions
3. (Automated) Cache eviction -> ITM refreshes
4. (Automated) Notification
DocuSign Signing
1. POST /worknet/composite-api/parser/signUrl -> Get signing URL
2. User redirected to DocuSign -> Signs document
3. (Automated) Task status updated -> Task marked completed
Integration Points
| Integration | Direction | When | API/Method |
|---|---|---|---|
| ITM (Task Center) | Outbound | After action/sync | POST /cacheEvict/evictForUserList |
| Flowable | Outbound | Task actions | Flowable custom API (complete/claim/release) |
| SAP BTP/SCP | Outbound | Task actions | ScpActionUtil.actionOnTask() |
| SAP S4/ECC | Outbound | Task actions | Composite API (action config YAML) |
| SAP Ariba | Outbound | Task sync | AribaBlockingAPIService.triggerAPI() |
| SAP Concur | Outbound | Task sync | Composite API (scheduler) |
| SuccessFactors | Outbound | Task sync | Composite API (scheduler) |
| DocuSign | Outbound | Signing URL | Composite API + JWT assertion |
| Salesforce | Outbound | Task actions | Composite API + JWT assertion |
| WorkAccess | Outbound | Auth + groups | REST API calls |
| Messaging | Outbound | Notifications | POST /v1/notification/* |
| Config Server | Inbound | Startup | Spring Cloud Config |
Connector Configs (UI Module)
WorkNet includes a Connector Configs module in the CherryWork UI that provides a visual interface for managing source system connections, schedulers, and configurations.
Overview
The Connector Configs module is used to:
- View all source systems connected to WorkNet
- Manage schedulers running under each system
- View and edit DB structure configuration (column mappings)
- Monitor job execution history and status
Navigation Flow
Connector Configs (Main Page)
|
|- Lists all connected systems
|
|- Click a System (e.g., SCP)
| |
| |- Shows all schedulers under that system
| |
| '- Click on a Scheduler
| |
| |- DB Structure Config (view/edit JSON-to-DB mapping)
| '- Job Run History (start/end/duration/count/status/errors)
What Each Screen Shows
System List (Main Page)
| Column | Description |
|---|---|
| System ID | Unique identifier (e.g., SCP, Flowable, DocuSign) |
| System Name | Display name |
| Status | Active / Inactive |
| Number of Schedulers | Count of configured schedulers |
Scheduler List (Per System)
| Column | Description |
|---|---|
| Scheduler ID | Unique scheduler identifier |
| Process Name | Workflow/process being synced |
| Cron Expression | Schedule frequency |
| Last Run | Timestamp of last execution |
| Status | Running / Completed / Failed |
DB Structure Config (Per Scheduler)
| DB Column | JSON Path | Table |
|---|---|---|
| TASK_ID | getTasks./id | CW_ITM_WN_TASKS |
| STATUS | getTasks./status | CW_ITM_WN_TASKS |
| OWNER_ID | getTasks./recipientUsers | CW_ITM_WN_TASK_OWNERS |
Administrators can:
- View current mapping
- Edit JSON paths
- Add/remove column mappings
- Save changes (updates YAML configuration)
Job Run History (Per Scheduler)
| Column | Description |
|---|---|
| Job ID | Unique execution ID |
| Start Time | When the job started |
| End Time | When the job completed |
| Duration | Time taken (milliseconds) |
| Record Count | Number of tasks processed |
| Status | Completed / Failed / Running |
| Message | Success message or error details |
How Connector Configs Relates to YAML Files
| UI Element | Underlying YAML/Config |
|---|---|
| System list | System Master table + dbYaml/dbYamlFile.yaml |
| Scheduler list | SystemSchedularConfigDo table |
| DB Structure Config view/edit | dbStructureConfig/{fileName}.yaml |
| Job run history | CW_ITM_JOB_LOG table |
| Scheduler cron expression | SystemSchedularConfigDo.cronExpression |
Typical Admin Workflow via Connector Configs
1. Open Connector Configs -> see all systems
2. Click SCP -> see schedulers
3. Click scheduler
4. Verify DB Structure Config mapping
5. Edit mapping if needed -> Save
6. Check Job Run History
7. If failed -> inspect error -> fix config -> rerun
How to Use WorkNet
Viewing Your Tasks
- Open the CherryWork Task Center (ITM).
- You'll see all tasks across all connected systems in one inbox.
- Tasks can be filtered by system, status, process type, etc.
- Each task shows: title, source system, status, creation date, and priority.
Task Actions
| Action | What it Does | When to Use |
|---|---|---|
| Approve | Accepts the task/request and moves the process forward | When you agree with the request |
| Reject | Declines the task/request | When you disagree or the request is invalid |
| Claim | Takes personal ownership of a group task | When a task is assigned to your group and you want to work on it |
| Release | Returns a claimed task back to the group pool | When you can no longer work on a claimed task |
| Forward | Reassigns the task to a different person or group | When someone else should handle this task |
| Send Back | Returns the task to the previous step/person | When additional information or corrections are needed |
| Resubmit | Resubmits a task that was sent back | When you've made the corrections requested |
| Cancel Process | Stops the entire process | When the request is no longer needed |
Working on a Task (Step by Step)
- Find the task in your inbox.
- Claim it (if it's assigned to a group) — this prevents others from working on it simultaneously.
- Review the details — task attributes, attachments, history.
- Take action — click Approve, Reject, or another action button.
- Add comments (optional) — explain your decision.
- The system automatically:
- Updates the task status in WorkNet.
- Sends the action back to the source system (SAP, Flowable, etc.).
- Notifies relevant users.
- Routes to the next step (if applicable).